This repository was archived by the owner on Apr 12, 2024. It is now read-only.
docs(directive): Clarified and cleaned up directive guide #2888
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -63,7 +63,7 @@ api/ng.$rootScope.Scope#$digest digest} cycle. An example of interpolation is sh | |||
| here: | |||
|
|
|||
| <pre> | |||
| <a href="img/{{username}}.jpg">Hello {{username}}!</a> | |||
| <a ng-href="img/{{username}}.jpg">Hello {{username}}!</a> | |||
|
@ProLoser - can you take a look at my comments and rework this PR? Thanks. |
| * `?` - Don't raise an error. This makes the require dependency optional. | ||
| * `^` - Look for the controller on parent elements as well. | ||
| * `?` - Required dependency is optional. The parameter might be `null/undefined`. | ||
| * `^` - Look for the directive on parent/ancestor elements as well. |
There was a problem hiding this comment.
Maybe the ^? case should also be explicitly added here as (to me) it wasn't clear that both modifier could be specified.
There was a problem hiding this comment.
I would actually add a note above or below the bulleted items and not as an explicit item in the list. However re-reading my description, I think "Required dependency is optional" couldn't be any more confusing lol.
|
@ProLoser - is this ready to be reviewed now? |
|
@ProLoser - surely you have signed the CLA at some point? |
PR Checklist (Docs-only fix)
|
|
Rebased. |
- corrected terminology about how directives use `require` - added more variations to the DirectiveDefinitionObject - removed some slightly superfluous text docs(directive): Minor correction to example to avoid bad practice Anchor tags should use `ng-href` instead of `href` for interpolation. docs(directive): Supplementing DDO description DDO = Directive Definition Object Tweak recommended here: https://github.com/angular/angular.js/pull/2888/files#r4664565
|
Squashed |
|
As 454bcfa |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
require